Migrate docs to VitePress#489
Merged
dereuromark merged 1 commit intomasterfrom May 4, 2026
Merged
Conversation
- Reorganize docs/ into guide/, tasks/, admin/, reference/ with kebab-case file names - Add VitePress config with sidebar nav, local search, sitemap, lastUpdated, brand-colored theme, and SVG logo - Add GitHub Pages deploy workflow building from docs/ on push to master - Move CONTRIBUTING.md back to repo root for GitHub auto-link - Add docs URL to composer.json support metadata - Update root README.md to point to https://dereuromark.github.io/cakephp-queue/
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #489 +/- ##
=========================================
Coverage 77.54% 77.54%
Complexity 966 966
=========================================
Files 45 45
Lines 3238 3238
=========================================
Hits 2511 2511
Misses 727 727 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the docs from a flat
docs/sections/markdown layout to a structured VitePress site at https://dereuromark.github.io/cakephp-queue/.Structure
All section files renamed to kebab-case under topic folders. Internal markdown links rewritten to absolute VitePress paths. Co-located images preserved with relative paths. Local search, sitemap, lastUpdated timestamps, and brand-colored theme included. Custom SVG logo + favicon shipped under
docs/public/.Files of note
docs/.vitepress/config.ts— sidebar, nav, search, sitemap, lastUpdated, editLinkdocs/.vitepress/theme/custom.css— brand colors and hero glow.github/workflows/deploy-docs.yml— builds and publishes to GitHub Pages on push to master (paths-filter ondocs/**)CONTRIBUTING.md— moved fromdocs/back to repo root so GitHub's PR/issue UI auto-links itcomposer.json— addedsupport.docsURLREADME.md— points users at the deployed docs URLManual step required after merge
GitHub repo Settings → Pages → Source = "GitHub Actions" (one-time toggle so the deploy workflow can publish).
Heads-up
External bookmarks to
docs/sections/*.mdwill 404 after merge — intentional restructure cost. Worth a one-line note in the next release.